com.inscoper.api.ConnectionConfig¶

Base class for connection configuration. More...

Inherited by com.inscoper.api.AdvancedConnectionConfig, com.inscoper.api.EthernetConnectionConfig, com.inscoper.api.USBConnectionConfig

Public Functions¶

	Name
synchronized void	delete()
void	fromXML(XMLNode connectionNode) Provide connection information from the XML connection node.
void	toXML(XMLNode xmlParent) Export connection information in an XML node attached to the parent XML node.
EConnectionType	getType() Return the type of the current connection.
int	getTag() Get the tag of the current connection.
void	setTag(int tag) Set the tag of the current connection.
int	getRealType()
ConnectionConfig	createProxy(long cPtr, boolean cMemoryOwn)
AdvancedConnectionConfig	castToAdvancedConnectionConfig(ConnectionConfig connectionConfig)
USBConnectionConfig	castToUSBConnectionConfig(ConnectionConfig connectionConfig)
EthernetConnectionConfig	castToEthernetConnectionConfig(ConnectionConfig connectionConfig)

Protected Functions¶

	Name
	ConnectionConfig(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ConnectionConfig obj)

Detailed Description¶

public class com.inscoper.api.ConnectionConfig;

Base class for connection configuration.

Note: This class is non-copyable and non-movable.

This abstract class defines the interface for configuring different types of connections (e.g., USB, Ethernet) used by devices.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.delete, com.inscoper.api.EthernetConnectionConfig.delete, com.inscoper.api.USBConnectionConfig.delete

function fromXML¶

public void fromXML(
    XMLNode connectionNode
)

Provide connection information from the XML connection node.

Parameters:

connectionNode : The XML connection node containing connection information

Exceptions:

InscoperException if an error occurred

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.fromXML, com.inscoper.api.EthernetConnectionConfig.fromXML, com.inscoper.api.USBConnectionConfig.fromXML

Populates the connection configuration from the provided XML connection node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Export connection information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.toXML, com.inscoper.api.EthernetConnectionConfig.toXML, com.inscoper.api.USBConnectionConfig.toXML

Serializes the connection configuration to the specified parent XML node.

function getType¶

public EConnectionType getType()

Return the type of the current connection.

Return: The type of the current connection

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.getType, com.inscoper.api.EthernetConnectionConfig.getType, com.inscoper.api.USBConnectionConfig.getType

Retrieves the specific type of connection configuration.

function getTag¶

public int getTag()

Get the tag of the current connection.

Return: The current connection tag

Retrieves the tag identifier associated with this connection.

function setTag¶

public void setTag(
    int tag
)

Set the tag of the current connection.

Parameters:

tag : The current connection tag

Assigns a tag identifier to this connection.

function getRealType¶

public int getRealType()

function createProxy¶

public static ConnectionConfig createProxy(
    long cPtr,
    boolean cMemoryOwn
)

function castToAdvancedConnectionConfig¶

public static AdvancedConnectionConfig castToAdvancedConnectionConfig(
    ConnectionConfig connectionConfig
)

function castToUSBConnectionConfig¶

public static USBConnectionConfig castToUSBConnectionConfig(
    ConnectionConfig connectionConfig
)

function castToEthernetConnectionConfig¶

public static EthernetConnectionConfig castToEthernetConnectionConfig(
    ConnectionConfig connectionConfig
)

Protected Functions Documentation¶

function ConnectionConfig¶

protected ConnectionConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.swigSetCMemOwn, com.inscoper.api.EthernetConnectionConfig.swigSetCMemOwn, com.inscoper.api.USBConnectionConfig.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplemented by: com.inscoper.api.AdvancedConnectionConfig.finalize, com.inscoper.api.EthernetConnectionConfig.finalize, com.inscoper.api.USBConnectionConfig.finalize

function getCPtr¶

protected static long getCPtr(
    ConnectionConfig obj
)

Updated on 2026-04-02 at 10:55:37 +0200